Open GoPro SDK/com.gopro.open_gopro.operations

Package-level declarations

This package contains enums and other data entities that are used to operate on the GoPro.

Types

AccessPointState

sealed class AccessPointState

Anti_Flicker

enum Anti_Flicker : Enum<Anti_Flicker> , IValuedEnum<UByte>

Anti-Flicker

ApiError

class ApiError(message: String) : Exception

ApScanEntry

data class ApScanEntry(val ssid: String, val signalStrengthBars: Int, val signalFrequencyMhz: Int, val isOpen: Boolean, val isAuthenticated: Boolean, val isConfigured: Boolean, val isBestSsid: Boolean, val isAssociated: Boolean)

ApScanResult

data class ApScanResult(val scanId: Int?, val totalEntries: Int?, val totalConfiguredSsids: Int?)

AudioOption

enum AudioOption : Enum<AudioOption>

AutoPowerDown

enum AutoPowerDown : Enum<AutoPowerDown> , IValuedEnum<UByte>

Auto Power Down

BitDepth

enum BitDepth : Enum<BitDepth> , IValuedEnum<UByte>

Bit Depth

BooleanEnum

enum BooleanEnum : Enum<BooleanEnum> , IValuedEnum<UByte>

CameraControlStatus

enum CameraControlStatus : Enum<CameraControlStatus>

CameraVolume

enum CameraVolume : Enum<CameraVolume> , IValuedEnum<UByte>

Camera Volume

CohnSettingRequest

@Serializable

class CohnSettingRequest(val disableCohn: Boolean)

CohnState

sealed class CohnState

CohnStatus

@Serializable

data class CohnStatus(val isEnabled: Boolean? = null, val ipAddress: String? = null, val macAddress: String? = null, val password: String? = null, val ssid: String? = null, val username: String? = null, val state: EnumCOHNNetworkState? = null, val status: EnumCOHNStatus? = null)

ControlMode

enum ControlMode : Enum<ControlMode> , IValuedEnum<UByte>

Control Mode

DateTimeHttpResponse

@Serializable

data class DateTimeHttpResponse(val date: String, val dst: Int, val time: String, val tzone: Int)

EasyModeSpeed

enum EasyModeSpeed : Enum<EasyModeSpeed> , IValuedEnum<UByte>

Easy Mode Speed

EasyNightPhoto

enum EasyNightPhoto : Enum<EasyNightPhoto> , IValuedEnum<UByte>

Easy Night Photo

EnableNightPhoto

enum EnableNightPhoto : Enum<EnableNightPhoto> , IValuedEnum<UByte>

Enable Night Photo

EnumCOHNNetworkState

sealed class EnumCOHNNetworkState : Message.Enum

EnumCOHNStatus

sealed class EnumCOHNStatus : Message.Enum

EnumFlatMode

sealed class EnumFlatMode : Message.Enum

EnumPresetGroup

sealed class EnumPresetGroup : Message.Enum

EnumPresetGroupIcon

sealed class EnumPresetGroupIcon : Message.Enum

EnumPresetIcon

sealed class EnumPresetIcon : Message.Enum

EnumPresetTitle

sealed class EnumPresetTitle : Message.Enum

FrameRate

enum FrameRate : Enum<FrameRate> , IValuedEnum<UByte>

Frame Rate

FramesPerSecond

enum FramesPerSecond : Enum<FramesPerSecond> , IValuedEnum<UByte>

Frames Per Second

Framing

enum Framing : Enum<Framing> , IValuedEnum<UByte>

Framing

GpDatetime

data class GpDatetime(val datetime: LocalDateTime, val utcOffset: UtcOffset, val isDaylightSavingsTime: Boolean)

Gps

enum Gps : Enum<Gps> , IValuedEnum<UByte>

GPS

GroupedMediaListItem

@Serializable

data class GroupedMediaListItem(val filename: String, val creationTime: Int, val modifiedTime: Int, val fileSize: Int, val lowResVideoSize: Int? = null, val lowResFileSize: Int? = null, val sessionId: String? = null, val isRaw: Boolean? = null, val groupId: Int, val firstGroupMemberId: Int? = null, val lastGroupMemberId: Int? = null, val missingFileIds: List<Int>? = null, val groupType: GroupMediaItemType) : MediaListItem

GroupMediaItemType

enum GroupMediaItemType : Enum<GroupMediaItemType>

HardwareInfo

@Serializable

data class HardwareInfo(val modelNumber: String, val modelName: String, val firmwareVersion: String, val serialNumber: String, val apSsid: String, val apMacAddress: String)

Hindsight

enum Hindsight : Enum<Hindsight> , IValuedEnum<UByte>

HindSight

Hypersmooth

enum Hypersmooth : Enum<Hypersmooth> , IValuedEnum<UByte>

Hypersmooth

IntEnum

interface IntEnum

IntEnumCompanion

interface IntEnumCompanion<T>

IUByteArrayCompanion

interface IUByteArrayCompanion<T : Enum<T>, IValuedEnum<*>>

IValuedEnum

interface IValuedEnum<T>

LapseMode

enum LapseMode : Enum<LapseMode> , IValuedEnum<UByte>

Lapse Mode

Led

enum Led : Enum<Led> , IValuedEnum<UByte>

LED

LensConfig

enum LensConfig : Enum<LensConfig>

LensProjection

enum LensProjection : Enum<LensProjection>

LivestreamConfigurationRequest

@Serializable

data class LivestreamConfigurationRequest(val url: String, val shouldEncode: Boolean? = null, val resolution: LivestreamResolution? = null, val minimumBitrate: Int? = null, val maximumBitrate: Int? = null, val startingBitRate: Int? = null, val fov: LivestreamFov? = null, val certificate: ByteArray? = null)

LivestreamError

enum LivestreamError : Enum<LivestreamError>

LivestreamFov

enum LivestreamFov : Enum<LivestreamFov>

LivestreamResolution

enum LivestreamResolution : Enum<LivestreamResolution>

LivestreamState

enum LivestreamState : Enum<LivestreamState>

LivestreamStatus

@Serializable

data class LivestreamStatus(val error: LivestreamError?, val status: LivestreamState?, val bitRate: Int?, val maxBitrate: Int?, val minBitrate: Int?, val isEncodingSupported: Boolean?, val isEncoding: Boolean?, val isLensSupported: Boolean?, val isMaxLensSupported: Boolean?, val supportedFov: List<LivestreamFov>, val supportedResolution: List<LivestreamResolution>, val isProtuneSupported: Boolean?)

MaxLens

enum MaxLens : Enum<MaxLens> , IValuedEnum<UByte>

Max Lens

MaxLensMod

enum MaxLensMod : Enum<MaxLensMod> , IValuedEnum<UByte>

Max Lens Mod

MaxLensModEnable

enum MaxLensModEnable : Enum<MaxLensModEnable> , IValuedEnum<UByte>

Max Lens Mod Enable

MediaContentType

enum MediaContentType : Enum<MediaContentType>

MediaFileList

@Serializable

data class MediaFileList(val directory: String, val files: List<MediaListItem>)

MediaFormat

enum MediaFormat : Enum<MediaFormat> , IValuedEnum<UByte>

Media Format

MediaId

@Serializable

data class MediaId(val filename: String, val folder: String)

MediaList

@Serializable

data class MediaList(val id: String, val media: List<MediaFileList>)

MediaListItem

@Serializable(with = MediaListItemSerializer::class)

sealed class MediaListItem

MediaMetadata

@Serializable(with = MediaMetadataSerializer::class)

sealed class MediaMetadata

MultiShotAspectRatio

enum MultiShotAspectRatio : Enum<MultiShotAspectRatio> , IValuedEnum<UByte>

Multi Shot Aspect Ratio

MultiShotFraming

enum MultiShotFraming : Enum<MultiShotFraming> , IValuedEnum<UByte>

Multi Shot Framing

NightlapseRate

enum NightlapseRate : Enum<NightlapseRate> , IValuedEnum<ULong>

Nightlapse Rate

NotifyPresetStatus

data class NotifyPresetStatus(val presetGroupArray: List<PresetGroup> = emptyList(), val unknownFields: Map<Int, UnknownField> = emptyMap()) : Message

OffloadState

enum OffloadState : Enum<OffloadState>

OgpVersionHttpResponse

@Serializable

data class OgpVersionHttpResponse(val version: String)

OperationUnsupportedForCommunicator

class OperationUnsupportedForCommunicator(operation: String, communicationType: CommunicationType) : Exception

PhotoHorizonLeveling

enum PhotoHorizonLeveling : Enum<PhotoHorizonLeveling> , IValuedEnum<UByte>

Photo Horizon Leveling

PhotoIntervalDuration

enum PhotoIntervalDuration : Enum<PhotoIntervalDuration> , IValuedEnum<UByte>

Photo Interval Duration

PhotoLens

enum PhotoLens : Enum<PhotoLens> , IValuedEnum<UByte>

Photo Lens

PhotoMediaMetadata

@Serializable

data class PhotoMediaMetadata(val contentType: MediaContentType, val creationTime: Long, val fileSize: Int, val id: String, val height: Int, val width: Int, val numHilights: Int, val isStabilized: Boolean, val isMetadataPresent: Boolean, val isTranscoded: Boolean, val isUploaded: Boolean, val offloadState: List<OffloadState>? = null, val parentId: String? = null, val fov: String? = null, val lensConfig: LensConfig? = null, val lensProjection: LensProjection? = null, val deprecated: String? = null, val isRaw: Boolean? = null, val isWideDynamicRange: Boolean? = null, val isHighDynamicRange: Boolean? = null) : MediaMetadata

PhotoMode

enum PhotoMode : Enum<PhotoMode> , IValuedEnum<UByte>

Photo Mode

PhotoOutput

enum PhotoOutput : Enum<PhotoOutput> , IValuedEnum<UByte>

Photo Output

PhotoSingleInterval

enum PhotoSingleInterval : Enum<PhotoSingleInterval> , IValuedEnum<UByte>

Photo Single Interval

PhotoTimelapseRate

enum PhotoTimelapseRate : Enum<PhotoTimelapseRate> , IValuedEnum<ULong>

Photo Timelapse Rate

Preset

data class Preset(val id: Int? = null, val mode: EnumFlatMode? = null, val titleId: EnumPresetTitle? = null, val titleNumber: Int? = null, val userDefined: Boolean? = null, val icon: EnumPresetIcon? = null, val settingArray: List<PresetSetting> = emptyList(), val isModified: Boolean? = null, val isFixed: Boolean? = null, val customName: String? = null, val unknownFields: Map<Int, UnknownField> = emptyMap()) : Message

PresetGroup

data class PresetGroup(val id: EnumPresetGroup? = null, val presetArray: List<Preset> = emptyList(), val canAddPreset: Boolean? = null, val icon: EnumPresetGroupIcon? = null, val modeArray: List<EnumFlatMode> = emptyList(), val unknownFields: Map<Int, UnknownField> = emptyMap()) : Message

PresetGroupId

enum PresetGroupId : Enum<PresetGroupId>

PresetInfo

@Serializable

data class PresetInfo(val customIconIds: List<Range>? = null, val customTitleIds: List<Range>? = null, val presetGroupArray: List<WrappedPresetGroup>? = null)

PresetSetting

data class PresetSetting(val id: Int? = null, val value: Int? = null, val isCaption: Boolean? = null, val unknownFields: Map<Int, UnknownField> = emptyMap()) : Message

Profiles

enum Profiles : Enum<Profiles> , IValuedEnum<UByte>

Profiles

Range

@Serializable

data class Range(val length: Int? = null, val start: Int? = null)

SerializationError

class SerializationError(message: String) : Exception

Represent SerializationExceptions.

SettingId

enum SettingId : Enum<SettingId> , IValuedEnum<UByte>

SetupLanguage

enum SetupLanguage : Enum<SetupLanguage> , IValuedEnum<UByte>

Setup Language

SetupScreenSaver

enum SetupScreenSaver : Enum<SetupScreenSaver> , IValuedEnum<UByte>

Setup Screen Saver

SingleMediaListItem

@Serializable

data class SingleMediaListItem(val filename: String, val creationTime: Int, val modifiedTime: Int, val fileSize: Int, val lowResVideoSize: Int? = null, val lowResFileSize: Int? = null, val sessionId: String? = null, val isRaw: Boolean? = null) : MediaListItem

StarTrailsLength

enum StarTrailsLength : Enum<StarTrailsLength> , IValuedEnum<UByte>

Star Trails Length

StatusId

enum StatusId : Enum<StatusId> , IValuedEnum<UByte>

WARNING!!! This file is auto-generated. Do not modify it manually

SystemVideoMode

enum SystemVideoMode : Enum<SystemVideoMode> , IValuedEnum<UByte>

System Video Mode

TimeLapseDigitalLenses

enum TimeLapseDigitalLenses : Enum<TimeLapseDigitalLenses> , IValuedEnum<UByte>

Time Lapse Digital Lenses

UpdateCustomPresetRequest

@Serializable

data class UpdateCustomPresetRequest(val name: String? = null, val iconId: Int? = null, val titleId: Int? = null)

VideoAspectRatio

enum VideoAspectRatio : Enum<VideoAspectRatio> , IValuedEnum<UByte>

Video Aspect Ratio

VideoBitRate

enum VideoBitRate : Enum<VideoBitRate> , IValuedEnum<UByte>

Video Bit Rate

VideoEasyMode

enum VideoEasyMode : Enum<VideoEasyMode> , IValuedEnum<UByte>

Video Easy Mode

VideoFraming

enum VideoFraming : Enum<VideoFraming> , IValuedEnum<UByte>

Video Framing

VideoHorizonLeveling

enum VideoHorizonLeveling : Enum<VideoHorizonLeveling> , IValuedEnum<UByte>

Video Horizon Leveling

VideoLens

enum VideoLens : Enum<VideoLens> , IValuedEnum<UByte>

Video Lens

VideoMediaMetadata

@Serializable

data class VideoMediaMetadata(val contentType: MediaContentType, val creationTime: Long, val fileSize: Int, val id: String, val height: Int, val width: Int, val numHilights: Int, val isStabilized: Boolean, val isMetadataPresent: Boolean, val isTranscoded: Boolean, val isUploaded: Boolean, val offloadState: List<OffloadState>? = null, val parentId: String? = null, val fov: String? = null, val lensConfig: LensConfig? = null, val lensProjection: LensProjection? = null, val deprecated: String? = null, val audioOption: AudioOption, val videoCodecLevel: Int, val videoCodecProfile: Int, val isClipped: Boolean, val duration: Int, val frameRate: Int, val frameRateDenominator: Int, val hilightList: List<Int>, val lrvFileSize: Int, val isProtuneAudio: Boolean, val isSubsampled: Boolean, val maxAutoHilightScore: Int? = null, val isProgressive: Boolean? = null) : MediaMetadata

VideoPerformanceMode

enum VideoPerformanceMode : Enum<VideoPerformanceMode> , IValuedEnum<UByte>

Video Performance Mode

VideoResolution

enum VideoResolution : Enum<VideoResolution> , IValuedEnum<UByte>

Video Resolution

VideoTimelapseRate

enum VideoTimelapseRate : Enum<VideoTimelapseRate> , IValuedEnum<UByte>

Video Timelapse Rate

WebcamDigitalLenses

enum WebcamDigitalLenses : Enum<WebcamDigitalLenses> , IValuedEnum<UByte>

Webcam Digital Lenses

WebcamError

enum WebcamError : Enum<WebcamError> , IntEnum

WebcamFov

enum WebcamFov : Enum<WebcamFov>

WebcamInfo

@Serializable

data class WebcamInfo(val isMaxLensSupported: Boolean, val is31Compatible: Boolean, val version: Int)

WebcamProtocol

enum WebcamProtocol : Enum<WebcamProtocol>

WebcamResolution

enum WebcamResolution : Enum<WebcamResolution>

WebcamState

@Serializable

data class WebcamState(val error: WebcamError, val status: WebcamStatus)

WebcamStatus

enum WebcamStatus : Enum<WebcamStatus> , IntEnum

WirelessBand

enum WirelessBand : Enum<WirelessBand> , IValuedEnum<UByte>

Wireless Band

WrappedPreset

@Serializable

data class WrappedPreset(val icon: EnumPresetIcon? = null, val id: Int? = null, val isFixed: Boolean? = null, val isModified: Boolean? = null, val mode: EnumFlatMode? = null, val settings: List<WrappedPresetSetting>? = null, val titleId: EnumPresetTitle? = null, val titleNumber: Int? = null, val isUserDefined: Boolean? = null, val customName: String? = null)

WrappedPresetGroup

@Serializable

data class WrappedPresetGroup(val canAddPreset: Boolean? = null, val icon: EnumPresetGroupIcon? = null, val id: EnumPresetGroup? = null, val modes: List<EnumFlatMode>? = null, val presets: List<WrappedPreset>? = null)

WrappedPresetSetting

@Serializable

data class WrappedPresetSetting(val id: Int? = null, val isCaption: Boolean? = null, val value: Int? = null)

Functions

isFinished

fun AccessPointState.isFinished(): Boolean

isOk

fun LivestreamError.isOk(): Boolean

fun LivestreamState.isOk(): Boolean

fun LivestreamStatus.isOk(): Boolean